Activities
latest
false
- Overview
- UI Automation
- UI-ANA-016 - Pull Open Browser URL
- UI-ANA-017 - ContinueOnError True
- UI-ANA-018 - List OCR/Image Activities
- UI-DBP-006 - Container Usage
- UI-DBP-013 - Excel Automation Misuse
- UI-DBP-030 - Forbidden Variables Usage In Selectors
- ST-DBP-021 - Hardcoded Timeout
- UI-PRR-001 - Simulate Click
- UI-PRR-002 - Simulate Type
- UI-PRR-003 - Open Application Misuse
- UI-PRR-004 - Hardcoded Delays
- UI-REL-001 - Large Idx in Selectors
- UI-SEC-004 - Selector Email Data
- UI-SEC-010 - App/Url Restrictions
- UI-USG-011 - Non Allowed Attributes
- SY-USG-013 - Private File Invoke
- SY-USG-014 - Incorrect Execution Template Placeholders
- Applications and technologies automated with UI Automation
- UiPath Browser Migration Tool
- Computer Vision Recorder
- Click
- Hover
- Type Secure Text
- Send Hotkey
- Type Into
- Check
- Select Item
- Select Multiple Items
- Get Text
- Set Text
- Activate
- Highlight
- Set Focus
- Anchor Base
- Context Aware Anchor
- Find Relative Element
- Indicate On Screen
- Element Exists
- Find Element
- Wait Element Vanish
- Find Children
- Get Ancestor
- Element Scope
- Get Attribute
- Set Clipping Region
- Get Position
- Take Screenshot
- Wait Attribute
- On Element Appear
- On Element Vanish
- Click Text
- Hover Text
- Find Text Position
- Get Full Text
- Get Visible Text
- Extract Structured Data
- Text Exists
- Click OCR Text
- Hover OCR Text
- Get OCR Text
- Find OCR Text Position
- Microsoft OCR
- Microsoft Project Oxford Online OCR
- Microsoft Azure Computer Vision OCR
- Tesseract OCR
- Google Cloud Vision OCR
- OCR Text Exists
- Click Image
- Hover Image
- Find Image Matches
- Image Exists
- Find Image
- Wait Image Vanish
- On Image Appear
- On Image Vanish
- Load Image
- Save Image
- Attach Browser
- Close Tab
- Go Back
- Go Forward
- Go Home
- Inject JS Script
- Navigate To
- Open Browser
- Refresh Browser
- Set Web Attribute
- Attach Window
- Close Window
- Get Active Window
- Hide Window
- Maximize Window
- Minimize Window
- Move Window
- Restore Window
- Show Window
- Export UI Tree
- Invoke ActiveX Method
- Inject .NET Code
- Click Trigger
- Key Press Trigger
- Click Image Trigger
- System Trigger
- Hotkey Trigger
- Mouse Trigger
- Get Event Info
- Monitor Events
- Get Source Element
- Replay User Event
- Block User Input
- Use Foreground
- Element Attribute Change Trigger
- Element State Change Trigger
- Callout
- Copy Selected Text
- Get From Clipboard
- Set To Clipboard
- Close Application
- Open Application
- Start Process
- Get Password
- Tooltip
- Click Picture on Screen
- Click Toolbar Button
- Read Statusbar
- Select Dates in Calendar
- Select Menu Item
- Expand Tree
- Call Transaction
- SAP Logon
- SAP Login
- Table Cell Scope
- SAP Session Attributes Change Trigger
- Expand ALV Tree
- Expand ALV Hierarchical Table
- Use Application/Browser
- Check App State
- Check/Uncheck
- Click
- Extract Table Data
- Get Text
- Get URL
- Go to URL
- Highlight
- Hover
- Keyboard Shortcuts
- Navigate Browser
- Select Item
- Take Screenshot
- Type Into
- Get Attribute
- Get Browser Data
- Set Browser Data
- Mouse Scroll
- Inject Js Script
- Drag and Drop
- For Each UI Element
- Application Event Trigger
- Click Event Trigger
- Keypress Event Trigger
- Set Text
- Check Element
- Fill Form
- Perform browser search and retrieve results using UI Automation APIs
- Web Browsing
- Find Images
- Click Images
- Trigger and Monitor Events
- Create and Override Files
- HTML Pages: Extract and Manipulate Information
- Window Manipulation
- Automated List Selection
- Find and Manipulate Window Elements
- Manage Text Automation
- Load and Process Images
- Manage Mouse Activated Actions
- Automate Application Runtime
- Automated Run of a Local Application
- Browser Navigation
- Web Automation
- Trigger Scope Example
- Computer Vision Local Server
- Mobile Automation
- Release notes
- Project compatibility
- Get Log Types
- Get Logs
- Get Page Source
- Get Device Orientation
- Get Session Identifier
- Install App
- Manage Current App
- Manage Other App
- Open DeepLink
- Open URL
- Mobile Device Connection
- Positional Swipe
- Press Hardware Button
- Set Device Orientation
- Take Screenshot
- Take Screenshot Part
- Element Exists
- Execute Command
- Get Attribute
- Get Selected Item
- Get Text
- Set Selected Item
- Set Text
- Swipe
- Tap
- Type Text
- Draw Pattern
- Terminal
UI Automation Activities
Last updated Apr 26, 2024
PREVIEWAPIs
APIs allow you to access and interact with the services offered in the
Manage Packages menu. You can use these APIs when you design coded
automations. Visit Coded Automations to learn about coded automations and how
to design them using APIs.
Note: Using Go to Definition
(
F12
) allows you to access the definition of UiPath APIs for a
certain service. We recommend relying only on the directly exposed APIs when you
implement coded automations. Other APIs that are not directly exposed with a service
are subject to change without prior notification.
APIs often have overloads, which means they provide multiple versions of the same method with different parameter options. Overloads allow you to customize the behavior of the API based on your specific requirements. For example, a UI Automation API may have an overload that accepts a timeout parameter to specify the maximum time to wait for a UI element to appear before ending execution.
By using the APIs with their respective overloads, you can easily achieve your desired automation logic and behavior.
This section includes the APIs found in the UiPath.MobileAutomation.API.Models service.
API | Description |
---|---|
Dispose | Releases resources used during automation, clears memory taken up
by these actions, and returns the Connection back
to its original state. This makes these resources available for
other tasks on a Connection .
|
DrawPattern | Draws a path marked by multiple points on the device screen. The points that create the path are recorded from the path of the finger on the device screen. You can add multiple finger paths to simulate screen interactions that involve multiple fingers. |
ElementExists | Returns a boolean variable that states whether a specified UI element exists. |
ExecuteCommand | Execute native mobile commands that are not associated with a specific endpoint. |
Finalize | Enables an object to perform cleanup operations and release resources before it is reclaimed by garbage collection. Implements the Object.Finalize method. |
GetAttribute | Retrieves an attribute of a specified UI element. |
GetDeviceOrientation | Retrieves the current orientation of the specified mobile device. |
GetLogTypes | Retrieves the log types from a device connected via the mobile
device Connection .
|
GetPageSource | Retrieves the page source from a mobile device connected via the
Connection class.
|
GetSelectedItem | Retrieves the selected item from a target UI element. |
GetSessionIdentifier | Retrieve the session ID of the current Mobile Device Manager connection to route HTTP commands to Appium endpoints so you can perform custom actions. |
GetSystemTime | Retrieves the current time of the device. |
GetText | Extracts the text from a specified UI element and returns it as a
String variable.
|
InstallApp | Installs a specified app on a mobile device connected via
Connection .
|
ManageCurrentApplication | Resets or launches the current app for this session. |
ManageOtherApplication | Manages other applications using commands. |
OpenDeepLink | Opens a deep link inside an application. |
OpenUrl | Opens a URL in Chrome. The current active application should be Chrome, having at least one opened tab, before calling this method. |
PositionalSwipe | Swipes to a predefined location on the screen with starting and ending points. |
PressHardwareButton | Presses a hardware button on the connected device. |
SaveLogs | Save logs of a specific type to a file. |
SetDeviceGeoLocation | Sets the current geo-location of the device. |
SetDeviceOrientation | Changes and then retrieves the orientation of the connected device. |
SetSelectedItem | Sets the selected item on a target UI element. |
SetText | Types the specified text into a target UI element, recognized by Mobile Automation. |
Swipe | The swipe operation iterates through multiple swipes on the list (up to MaxNumberOfSwipes) until it locates the specified element. |
TakeScreenshot | Takes a screenshot of the screen of the mobile device you are using with custom dimensions specified in the Height and Width parameters. |
Tap | Returns a boolean variable that states whether a specified UI element exists. The API doesn't have a return value, but if the specified UI element exists (boolean value), then it performs tap operations on it. |
TypeText | Takes the content typed through the keyboard and pastes it into the currently active UI element. To paste the text inside the element that you want, you need to focus wherever on the UI where you want to paste the text. You can use this API when automating applications for which you need to type text through the keyboard, but without a target element that is recognized by Mobile Automation. |
Use the following format, to call an API from the corresponding service:
service.API
. For example, system.GetAsset
.
To use Mobile Automation APIs, you first establish a connection to your device and
application (visit Connection to learn more), then call the desired automation methods on this
connection, such as
connection.Tap(<selector>);
or var
orientation = connection.GetDeviceOrientation();
.